Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Initial sphinx docs #195

Merged
merged 4 commits into from
Feb 27, 2019
Merged

[WIP] Initial sphinx docs #195

merged 4 commits into from
Feb 27, 2019

Conversation

AstraLuma
Copy link
Member

An initial run at Sphinx and ReadTheDocs.

@nbraud nbraud mentioned this pull request Jan 24, 2019
Closed
pathunstrom
pathunstrom approved these changes Jan 24, 2019
View reviewed changes
Copy link
Collaborator

@pathunstrom pathunstrom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fine. Will merge this weekend.

@pathunstrom
Copy link
Collaborator

@astronouth7303 Got a big question: When does readthedocs do a new build? Is it "per release" or every update to master?

@AstraLuma
Copy link
Member Author

Depends on the rtd configuration, because rtd has rich version/tag support.

In general, I think it's rebuilt if a given branch or tag is updated.

@AstraLuma
Copy link
Member Author

Also, I feel like a lot more needs to be written? Unless you're ok with this as a starting point.

@AstraLuma AstraLuma merged commit dfd2f5f into ppb:master Feb 27, 2019
@AstraLuma AstraLuma deleted the rtd-in-da-repo branch February 27, 2019 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pathunstrom pathunstrom pathunstrom approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AstraLuma @pathunstrom